Package com.netscape.certsrv.logging
Interface ILogger
- All Known Implementing Classes:
Logger
,SignedAuditLogger
public interface ILogger
An interface represents a logger for certificate server. This object is used to
issue log messages for the various types of logging event types. A log message results
in a ILogEvent being created. This event is then placed on a ILogQueue to be ultimately
written to the destination log file. This object also maintains a collection of LogEventFactory objects
which are used to create the supported types of ILogEvents. CMS comes out of the box with three event
types: "signedAudit", "system", and "audit".
- Version:
- $Revision$, $Date$
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final LogCategory
log class: audit event.static final LogCategory
log class: SignedAudit event.static final String
static final boolean
indicate the log message has more than one linestatic final boolean
indicate the log message has one linestatic final int
log level: used by servlet to retrieve all level logsstatic final String
static final int
log level: indicate this log entry is catastrphe infostatic final String
static final int
Debug level is depreciated since CMS6.1.static final String
static final int
log level: indicate this log entry is fail/error infostatic final String
static final int
log level: indicate this log entry is for info notestatic final String
static final int
log level: indicate this log entry is about misconfigurationstatic final String
static final int
log level: indicate this log entry is security infostatic final String
static final int
log level: indicate this log entry is warning infostatic final String
static final String
A constant string value used to denote a single "non-role" identity in signed audit log messagesstatic final int
NT event type: correspont to log level LL_FAILURE and abovestatic final int
NT event type: correspond to log level LL_DEBUG or LL_INFOstatic final int
NT event type: correspond to log level LL_WARNINGstatic final String
static final String
static final String
log class: system event.static final LogSource
log source: identify the log entry is from acl subsystemstatic final LogSource
log source: identify the log entry is from admin subsystemstatic final LogSource
log source: used by servlet to retrieve all logsstatic final LogSource
log source: identify the log entry is from authentication subsystemstatic final LogSource
log source: identify the log entry is from authorization subsystemstatic final LogSource
log source: identify the log entry is from CAstatic final LogSource
log source: identify the log entry is from database subsystemstatic final LogSource
log source: identify the log entry is from http subsystemstatic final LogSource
log source: identify the log entry is from KRAstatic final LogSource
log source: identify the log entry is from ldap subsystemstatic final LogSource
static final LogSource
log source: identify the log entry is from other subsystem eg.static final LogSource
log source: identify the log entry is from RAstatic final LogSource
log source: identify the log entry is from request queue subsystemstatic final LogSource
log source: identify the log entry is from signed auditstatic final LogSource
log source: identify the log entry is from CrossCertPair subsystemstatic final LogSource
static final LogSource
log source: identify the log entry is from usergrp subsystemstatic final LogSource
log source: identify the log entry is from CrossCertPair subsystemstatic final String
Constant string values associated with the type of certificate processing stored in the "InfoName" field in certain signed audit log messagesstatic final String
static final String
A constant string value used to denote an "empty", or "null", data value in signed audit log messagesstatic final String
A constant string value used to denote a "non-applicable" data value in signed audit log messagesstatic final String
static final String
"Outcome" for events logged in signed audit log messagesstatic final String
"SubjectID" for system-initiated events logged in signed audit log messagesstatic final String
A constant string value used to denote a single "unknown" identity in signed audit log messages -
Method Summary
Modifier and TypeMethodDescriptioncreate
(LogCategory evtClass, LogSource source, int level, String msg, Object[] params, boolean multiline) void
log
(LogCategory evtClass, LogSource source, int level, String msg) Logs an event to the log queue.void
log
(LogCategory evtClass, LogSource source, int level, String msg, boolean multiline) Logs an event to the log queue.void
log
(LogCategory evtClass, LogSource source, int level, String msg, Object param) Logs an event to the log queue.void
log
(LogCategory evtClass, LogSource source, int level, String msg, Object[] params) Logs an event to the log queue.void
log
(LogCategory evtClass, LogSource source, int level, String msg, Object param, boolean multiline) Logs an event to the log queue.void
log
(LogCategory evtClass, LogSource source, String msg) Logs an event to the log queue.void
log
(LogCategory evtClass, LogSource source, String msg, boolean multiline) Logs an event to the log queue.
-
Field Details
-
EV_AUDIT
log class: audit event. -
PROP_AUDIT
- See Also:
-
PROP_SYSTEM
log class: system event. System event with log level >= LL_FAILURE will also be logged in error log- See Also:
-
EV_SIGNED_AUDIT
log class: SignedAudit event. -
PROP_SIGNED_AUDIT
- See Also:
-
S_ALL
log source: used by servlet to retrieve all logs -
S_KRA
log source: identify the log entry is from KRA -
S_RA
log source: identify the log entry is from RA -
S_CA
log source: identify the log entry is from CA -
S_HTTP
log source: identify the log entry is from http subsystem -
S_DB
log source: identify the log entry is from database subsystem -
S_AUTHENTICATION
log source: identify the log entry is from authentication subsystem -
S_ADMIN
log source: identify the log entry is from admin subsystem -
S_LDAP
log source: identify the log entry is from ldap subsystem -
S_REQQUEUE
log source: identify the log entry is from request queue subsystem -
S_ACLS
log source: identify the log entry is from acl subsystem -
S_USRGRP
log source: identify the log entry is from usergrp subsystem -
S_OCSP
-
S_AUTHORIZATION
log source: identify the log entry is from authorization subsystem -
S_SIGNED_AUDIT
log source: identify the log entry is from signed audit -
S_XCERT
log source: identify the log entry is from CrossCertPair subsystem -
S_TKS
log source: identify the log entry is from CrossCertPair subsystem -
S_TPS
-
S_OTHER
log source: identify the log entry is from other subsystem eg. policy, security, connector,registration -
LL_ALL
static final int LL_ALLlog level: used by servlet to retrieve all level logs- See Also:
-
LL_ALL_STRING
- See Also:
-
LL_DEBUG
static final int LL_DEBUGDebug level is depreciated since CMS6.1. Please use CMS.debug() to output messages to debugging file.- See Also:
-
LL_DEBUG_STRING
- See Also:
-
LL_INFO
static final int LL_INFOlog level: indicate this log entry is for info note- See Also:
-
LL_INFO_STRING
- See Also:
-
LL_WARN
static final int LL_WARNlog level: indicate this log entry is warning info- See Also:
-
LL_WARN_STRING
- See Also:
-
LL_FAILURE
static final int LL_FAILURElog level: indicate this log entry is fail/error info- See Also:
-
LL_FAILURE_STRING
- See Also:
-
LL_MISCONF
static final int LL_MISCONFlog level: indicate this log entry is about misconfiguration- See Also:
-
LL_MISCONF_STRING
- See Also:
-
LL_CATASTRPHE
static final int LL_CATASTRPHElog level: indicate this log entry is catastrphe info- See Also:
-
LL_CATASTRPHE_STRING
- See Also:
-
LL_SECURITY
static final int LL_SECURITYlog level: indicate this log entry is security info- See Also:
-
LL_SECURITY_STRING
- See Also:
-
SYSTEM_UID
"SubjectID" for system-initiated events logged in signed audit log messages- See Also:
-
UNIDENTIFIED
A constant string value used to denote a single "unknown" identity in signed audit log messages- See Also:
-
NONROLEUSER
A constant string value used to denote a single "non-role" identity in signed audit log messages- See Also:
-
SUCCESS
"Outcome" for events logged in signed audit log messages- See Also:
-
FAILURE
- See Also:
-
SIGNED_AUDIT_NON_APPLICABLE
A constant string value used to denote a "non-applicable" data value in signed audit log messages- See Also:
-
SIGNED_AUDIT_EMPTY_VALUE
A constant string value used to denote an "empty", or "null", data value in signed audit log messages- See Also:
-
SIGNED_AUDIT_ACCEPTANCE
Constant string values associated with the type of certificate processing stored in the "InfoName" field in certain signed audit log messages- See Also:
-
SIGNED_AUDIT_CANCELLATION
- See Also:
-
SIGNED_AUDIT_REJECTION
- See Also:
-
NT_INFO
static final int NT_INFONT event type: correspond to log level LL_DEBUG or LL_INFO- See Also:
-
NT_WARN
static final int NT_WARNNT event type: correspond to log level LL_WARNING- See Also:
-
NT_ERROR
static final int NT_ERRORNT event type: correspont to log level LL_FAILURE and above- See Also:
-
L_MULTILINE
static final boolean L_MULTILINEindicate the log message has more than one line- See Also:
-
L_SINGLELINE
static final boolean L_SINGLELINEindicate the log message has one line- See Also:
-
-
Method Details
-
log
Logs an event to the log queue.- Parameters:
evtClass
- What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT.source
- The source of the log event.msg
- The detail message to be logged.
-
log
Logs an event to the log queue.- Parameters:
evtClass
- What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT.source
- The source of the log event.level
- The level of the log event.msg
- The detail message to be logged.
-
log
Logs an event to the log queue.- Parameters:
evtClass
- What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT.source
- The source of the log event.level
- The level of the log event.msg
- The detail message to be logged.param
- The parameter in the detail message.
-
log
Logs an event to the log queue.- Parameters:
evtClass
- What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT.source
- The source of the log event.level
- The level of the log event.msg
- The detail message to be logged.params
- The parameters in the detail message.
-
log
Logs an event to the log queue.- Parameters:
evtClass
- What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT.source
- The source of the log event.msg
- The detail message to be logged.multiline
- true If the message has more than one line, otherwise false.
-
log
Logs an event to the log queue.- Parameters:
evtClass
- What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT.source
- The source of the log event.level
- The level of the log event.msg
- The detail message to be logged.multiline
- True if the message has more than one line, otherwise false.
-
log
void log(LogCategory evtClass, LogSource source, int level, String msg, Object param, boolean multiline) Logs an event to the log queue.- Parameters:
evtClass
- What kind of event it is: EV_AUDIT or EV_SYSTEM or EV_SIGNED_AUDIT.source
- The source of the log event.level
- The level of the log event.msg
- The detail message to be logged.param
- The parameter in the detail message.multiline
- True if the message has more than one line, otherwise false.
-
create
LogEvent create(LogCategory evtClass, LogSource source, int level, String msg, Object[] params, boolean multiline)
-